<!-- HTML header for doxygen 1.8.12-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pymoduleconnector: pymoduleconnector.moduleconnectorwrapper.DataRecord Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    <!-- Platform title -->
    <div class="page-title-bar container-fluid">
      <div id="projectalign" class="row">
        <div id="projectname" class="col-sm-12">pymoduleconnector
          &#160;<span id="projectnumber">1.6.2</span>
        </div>
        <div id="projectbrief" class="col-sm-12">A Python wrapper for XeThru ModuleConnector</div>
      </div>
    </div>
    <div class="topbar">
      <div class="container">
        <div id="titlearea">
          <div class="xethru-logo">
            <img src="xethru-logo_220x55HD.png" alt="Novelda XeThru web site" id="logo-image" />
          </div>
        </div>
        <!-- end header part -->
        <!-- Generated by Doxygen 1.8.12 -->
        <!--BEGIN MAIN-NAV AND SEARCHENGINE-->
        <div id="main-nav"></div>
        <!--END MAIN-NAV AND SEARCHENGINE-->
      </div>
    </div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>pymoduleconnector</b></li><li class="navelem"><b>moduleconnectorwrapper</b></li><li class="navelem"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml">DataRecord</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record-members.xhtml">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">pymoduleconnector.moduleconnectorwrapper.DataRecord Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Encapsulates data and information about one data record on disk.  
 <a href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9b26c39c0f18fa863d81f50c03878847"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml#a9b26c39c0f18fa863d81f50c03878847">__init__</a> (self)</td></tr>
<tr class="memdesc:a9b26c39c0f18fa863d81f50c03878847"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>init</b>(XeThru::DataRecord self) -&gt; <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml" title="Encapsulates data and information about one data record on disk. ">DataRecord</a>  <a href="#a9b26c39c0f18fa863d81f50c03878847">More...</a><br /></td></tr>
<tr class="separator:a9b26c39c0f18fa863d81f50c03878847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6864ea93c9cc36cfad83e23f56ec94cb"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml#a6864ea93c9cc36cfad83e23f56ec94cb">get_data</a> (self)</td></tr>
<tr class="memdesc:a6864ea93c9cc36cfad83e23f56ec94cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">get_data(DataRecord self) -&gt; ucVector  <a href="#a6864ea93c9cc36cfad83e23f56ec94cb">More...</a><br /></td></tr>
<tr class="separator:a6864ea93c9cc36cfad83e23f56ec94cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1ab0c5b058c388cfe6d6d59d6332e8a"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml#ad1ab0c5b058c388cfe6d6d59d6332e8a">is_csv_header</a> (self)</td></tr>
<tr class="memdesc:ad1ab0c5b058c388cfe6d6d59d6332e8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">is_csv_header(DataRecord self) -&gt; bool  <a href="#ad1ab0c5b058c388cfe6d6d59d6332e8a">More...</a><br /></td></tr>
<tr class="separator:ad1ab0c5b058c388cfe6d6d59d6332e8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3828b4292e27aa153c5ed13fbd75348"><td class="memItemLeft" align="right" valign="top"><a id="ad3828b4292e27aa153c5ed13fbd75348"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>to_binary_packet</b> (self, ok=None)</td></tr>
<tr class="separator:ad3828b4292e27aa153c5ed13fbd75348"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5eac4d39738a23605417341155fb1919"><td class="memItemLeft" align="right" valign="top"><a id="a5eac4d39738a23605417341155fb1919"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>to_sleep_data</b> (self, ok=None)</td></tr>
<tr class="separator:a5eac4d39738a23605417341155fb1919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5042fdb0c28970da87c67d307c2c2fae"><td class="memItemLeft" align="right" valign="top"><a id="a5042fdb0c28970da87c67d307c2c2fae"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>to_vitalsigns_data</b> (self, ok=None)</td></tr>
<tr class="separator:a5042fdb0c28970da87c67d307c2c2fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7863bd1e1afc254a98b93a1bf2d2e123"><td class="memItemLeft" align="right" valign="top"><a id="a7863bd1e1afc254a98b93a1bf2d2e123"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>this</b></td></tr>
<tr class="separator:a7863bd1e1afc254a98b93a1bf2d2e123"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af0392368d6570d63ea4ac64df24a0b60"><td class="memItemLeft" align="right" valign="top"><a id="af0392368d6570d63ea4ac64df24a0b60"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> = _swig_property(_moduleconnectorwrapper.DataRecord_data_get, _moduleconnectorwrapper.DataRecord_data_set)</td></tr>
<tr class="separator:af0392368d6570d63ea4ac64df24a0b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad85b0fb2a561b378f03fb7629cc27214"><td class="memItemLeft" align="right" valign="top"><a id="ad85b0fb2a561b378f03fb7629cc27214"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>data_type</b> = _swig_property(_moduleconnectorwrapper.DataRecord_data_type_get, _moduleconnectorwrapper.DataRecord_data_type_set)</td></tr>
<tr class="separator:ad85b0fb2a561b378f03fb7629cc27214"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade0b481c24c64c713e256270ec55d744"><td class="memItemLeft" align="right" valign="top"><a id="ade0b481c24c64c713e256270ec55d744"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>epoch</b> = _swig_property(_moduleconnectorwrapper.DataRecord_epoch_get, _moduleconnectorwrapper.DataRecord_epoch_set)</td></tr>
<tr class="separator:ade0b481c24c64c713e256270ec55d744"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad37f7c1e099a33472406064467005385"><td class="memItemLeft" align="right" valign="top"><a id="ad37f7c1e099a33472406064467005385"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>is_valid</b> = _swig_property(_moduleconnectorwrapper.DataRecord_is_valid_get, _moduleconnectorwrapper.DataRecord_is_valid_set)</td></tr>
<tr class="separator:ad37f7c1e099a33472406064467005385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97abfe178f06f8c56ea512d58f91f8ac"><td class="memItemLeft" align="right" valign="top"><a id="a97abfe178f06f8c56ea512d58f91f8ac"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>is_user_header</b> = _swig_property(_moduleconnectorwrapper.DataRecord_is_user_header_get, _moduleconnectorwrapper.DataRecord_is_user_header_set)</td></tr>
<tr class="separator:a97abfe178f06f8c56ea512d58f91f8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a574fe3b976ca19797b855b121dde8dea"><td class="memItemLeft" align="right" valign="top"><a id="a574fe3b976ca19797b855b121dde8dea"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>meta_version</b> = _swig_property(_moduleconnectorwrapper.DataRecord_meta_version_get, _moduleconnectorwrapper.DataRecord_meta_version_set)</td></tr>
<tr class="separator:a574fe3b976ca19797b855b121dde8dea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encapsulates data and information about one data record on disk. </p>
<p>One record is a collection of fields as specified by the Xethru File Formats doc for the given data type.</p>
<dl class="section note"><dt>Note</dt><dd>Data and information is valid only if is_valid is true.</dd></dl>
<h2>Parameters </h2>
<ul>
<li><code>data</code> : contains bytes as specified by Xethru File Formats doc if is_user_header is false. Otherwise contains custom user header as supplied by the user (see <em><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_recording_options.xhtml#ad1e010d865745ded5018f4dc3b70c6cf" title="set_user_header(RecordingOptions self, ucVector header) ">RecordingOptions::set_user_header</a></em>).</li>
<li><code>data_type</code> : Specifies the data type for the record (see <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_type.xhtml" title="Proxy of C++ XeThru::DataType class. ">DataType</a>).</li>
<li><code>epoch</code> : Specifies the date/time the record was written to disk as number of milliseconds since 1970.01.01.</li>
<li><code>is_valid</code> : Specifies whether the fields in this struct is valid.</li>
<li><code>is_user_header</code> : Specifies whether the data contains custom user header.</li>
</ul>
<h2>Attributes </h2>
<ul>
<li><code>data</code> : <code>Bytes</code></li>
<li><code>data_type</code> : <code>uint32_t</code></li>
<li><code>epoch</code> : <code>int64_t</code></li>
<li><code>is_valid</code> : <code>bool</code></li>
<li><code>is_user_header</code> : <code>bool</code></li>
<li><code>meta_version</code> : <code>uint32_t</code></li>
</ul>
<p>C++ includes: Data.hpp </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9b26c39c0f18fa863d81f50c03878847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b26c39c0f18fa863d81f50c03878847">&sect;&nbsp;</a></span>__init__()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.DataRecord.__init__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><b>init</b>(XeThru::DataRecord self) -&gt; <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_data_record.xhtml" title="Encapsulates data and information about one data record on disk. ">DataRecord</a> </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6864ea93c9cc36cfad83e23f56ec94cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6864ea93c9cc36cfad83e23f56ec94cb">&sect;&nbsp;</a></span>get_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.DataRecord.get_data </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get_data(DataRecord self) -&gt; ucVector </p>
<p>Const reference accessor to data.</p>
<p>In particular useful from Python to avoid unecessary overhead when read-only access to data is needed.</p>
<h2>Returns </h2>
<p>a const reference to the data. </p>

</div>
</div>
<a id="ad1ab0c5b058c388cfe6d6d59d6332e8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1ab0c5b058c388cfe6d6d59d6332e8a">&sect;&nbsp;</a></span>is_csv_header()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.DataRecord.is_csv_header </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>is_csv_header(DataRecord self) -&gt; bool </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pymoduleconnector/moduleconnectorwrapper/__init__.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<hr class="footer"/>
 <address class="footer">
 Copyright &copy; 2016 Novelda AS - <a href="http://www.xethru.com">www.xehtru.com</a><br />
 <small>
  Generated by &#160;<a href="http://www.doxygen.org/index.html">
  <img class="footer" src="doxygen.png" alt="doxygen"/>
  </a> 1.8.12
 </small>
 </address>
</body>
</html>
